org.eclipse.vtp.framework.interactions.core.commands
Class ExternalReferenceCommand

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand
      org.eclipse.vtp.framework.interactions.core.commands.ExternalReferenceCommand

All Implemented Interfaces:

ICommand

public final class ExternalReferenceCommand
extends ConversationCommand

A command that sends an external reference to the user.

Author:

Lonnie Pryor

Field Summary

Fields inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

INPUT_TYPE_CUSTOM, INPUT_TYPE_FILE, OUTPUT_TYPE_FILE, OUTPUT_TYPE_TEXT

Constructor Summary

ExternalReferenceCommand()
Creates a new ExternalReferenceCommand.

Method Summary

java.lang.Object	exportContents() Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.
java.lang.String[]	getInputArgumentNames() Returns the names of the arguments the resource takes as input.
java.lang.String	getInputArgumentValue(java.lang.String name) Returns the value of an argument the resource takes as input.
java.lang.String[]	getOutputArgumentNames() Returns the names of the arguments the resource returns as output.
java.lang.String	getOutputArgumentValue(java.lang.String name) Returns the value of an argument the resource returns as output.
java.lang.String[]	getParameterNames() Returns the names of the parameters that will be returned from the interaction.
java.lang.String[]	getParameterValues(java.lang.String name) Returns the values of a parameter to be set when the process resumes.
java.lang.String	getReferenceName() Returns the name of the external reference being called.
java.lang.String	getReferenceURI() Returns the URI of the external reference.
void	importContents(java.lang.Object contents) Configures the contents of this command with a structure previously returned from ICommand.exportContents().
void	setInputArgumentValue(java.lang.String name, java.lang.String value) Configures the value of an argument the resource takes as input.
void	setOutputArgumentValue(java.lang.String name, java.lang.String value) Configures the value of an argument the resource returns as output.
void	setParameterValues(java.lang.String name, java.lang.String[] values) Configures a parameter set when the current process resumes.
void	setReferenceName(java.lang.String inputName) Sets the name of the external reference being called.
void	setReferenceURI(java.lang.String referenceURI) Sets the URI of the external reference.

Methods inherited from class org.eclipse.vtp.framework.interactions.core.commands.ConversationCommand

accept

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalReferenceCommand

public ExternalReferenceCommand()

Creates a new ExternalReferenceCommand.

Method Detail

getReferenceName

public java.lang.String getReferenceName()

Returns the name of the external reference being called.

Returns:

The name of the external reference being called.

setReferenceName

public void setReferenceName(java.lang.String inputName)

Sets the name of the external reference being called.

Parameters:

inputName - The name of the external reference being called.

getReferenceURI

public java.lang.String getReferenceURI()

Returns the URI of the external reference.

Returns:

The URI of the external reference.

setReferenceURI

public void setReferenceURI(java.lang.String referenceURI)

Sets the URI of the external reference.

Parameters:

referenceURI - The URI of the external reference.

getInputArgumentNames

public java.lang.String[] getInputArgumentNames()

Returns the names of the arguments the resource takes as input.

Returns:

The names of the arguments the resource takes as input.

getInputArgumentValue

public java.lang.String getInputArgumentValue(java.lang.String name)

Returns the value of an argument the resource takes as input.

Parameters:

name - The name of the argument to be passed.

Returns:

The value of an argument the resource takes as input.

setInputArgumentValue

public void setInputArgumentValue(java.lang.String name,
                                  java.lang.String value)

Configures the value of an argument the resource takes as input.

Parameters:

name - The name of the argument to pass.

value - The value of the argument.

getOutputArgumentNames

public java.lang.String[] getOutputArgumentNames()

Returns the names of the arguments the resource returns as output.

Returns:

The names of the arguments the resource returns as output.

getOutputArgumentValue

public java.lang.String getOutputArgumentValue(java.lang.String name)

Returns the value of an argument the resource returns as output.

Parameters:

name - The name of the argument to be returned.

Returns:

The value of an argument the resource returns as output.

setOutputArgumentValue

public void setOutputArgumentValue(java.lang.String name,
                                   java.lang.String value)

Configures the value of an argument the resource returns as output.

Parameters:

name - The name of the argument to return.

value - The value of the argument.

getParameterNames

public java.lang.String[] getParameterNames()

Returns the names of the parameters that will be returned from the interaction.

Returns:

The names of the parameters that will be returned from the interaction.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Returns the values of a parameter to be set when the process resumes.

Parameters:

name - The name of the parameter to be set.

Returns:

The values that specified parameter will be set to.

setParameterValues

public void setParameterValues(java.lang.String name,
                               java.lang.String[] values)

Configures a parameter set when the current process resumes.

Parameters:

name - The name of the parameter to set.

values - The values to set the parameter to.

exportContents

public java.lang.Object exportContents()

Description copied from interface: ICommand

Exports the contents of this command to a simple structure of arrays and serializable values from java.lang.

Returns:

A serializable structure this command can be re-constituted from.

importContents

public void importContents(java.lang.Object contents)

Description copied from interface: ICommand

Configures the contents of this command with a structure previously returned from ICommand.exportContents().

Parameters:

contents - The exported contents structure to load from.